//=============================================================================
// System  : MatchKit
// File    : WhiteSpacePattern.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System;
using System.Runtime.Serialization;

namespace MatchKit.Patterns
{
	/// <summary>
	/// Provides the logic to match a single whitespace character.
	/// </summary>
	/// <threadsafety static="true" instance="false" />
	/// <serialization binary="true" contract="true" />
	/// <conceptualLink target="0b785773-b793-4cc4-acc4-6688cdb226b6" />
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	#if DC
	[DataContract]
	#endif
	#if SZ
	[Serializable]
	#endif
	public sealed class WhiteSpacePattern : BasePattern
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.Patterns.WhiteSpacePattern"/> class. 
		/// </summary>
		public WhiteSpacePattern()
		{
			// empty
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="T:MatchKit.Patterns.WhiteSpacePattern"/> class. 
		/// </summary>
		/// <param name="includeNewLines">Value specifing whether including newline in the match.</param>
		public WhiteSpacePattern(bool includeNewLines)
		{
			_includeNewLines = includeNewLines;
		}

		private bool _includeNewLines;
		/// <summary>
		/// Gets or sets a value specifing whether including newlines in the match.
		/// <br/>
		/// Default vaule is <b>false</b>.
		/// </summary>
		/// <serialization member="true" />
		#if DC
		[DataMember]
		#endif
		public bool IncludeNewLines
		{
			get { return _includeNewLines; }
			set { _includeNewLines = value; }
		}

		/// <inheritdoc />
		protected override Match OnMatch(MatchContext context)
		{
			if (!context.IsWhiteSpace)
				return Error(context);
			var ch = context.Current;
			if (!_includeNewLines)
			{
				if (ch == '\r' || ch == '\n')
					return Error(context, "Newlines (CR or LF) not allowed");
			}
			context.NextCharacter();
			return Success(context, ch);
		}

		/// <inheritdoc />
		public override string HelpString
		{
			get
			{
				return "Whitespace"
					+ (_includeNewLines ? string.Empty : " excluded newline (CR or LF)");
			}
		}
	}
}
